<!-- HTML header for doxygen 1.8.20-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
	<meta http-equiv="X-UA-Compatible" content="IE=9"/>
	<meta name="generator" content="Doxygen 1.9.4"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>Raspberry Pi Pico SDK: include/hardware/xip_cache.h File Reference</title>
	<!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
	<script type="text/javascript" src="jquery.js"></script>
	<script type="text/javascript" src="dynsections.js"></script>
	<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
	<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
    <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
	<link href="doxygen.css" rel="stylesheet" type="text/css" />
	<link href="normalise.css" rel="stylesheet" type="text/css"/>
<link href="main.css" rel="stylesheet" type="text/css"/>
<link href="styles.css" rel="stylesheet" type="text/css"/>
</head>
<body>
	<div class="navigation-mobile">
		<div class="logo--mobile">
			<a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
		</div>
		<div class="navigation-toggle">
			<span class="line-1"></span>
			<span class="line-2">
				<p>Menu Toggle</p>
			</span>
			<span class="line-3"></span>
		</div>
	</div>
	<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
		<div class="logo">
			<a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
			<span style="display: inline-block; margin-top: 10px;">
				v2.1.0
			</span>
		</div>
		<div class="navigation-footer">
			<img src="logo-mobile.svg" alt="Raspberry Pi">
			<a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
		</div>
<!-- 		<div class="search">
			<form>
				<input type="search" name="search" id="search" placeholder="Search">
				<input type="submit" value="Search">
			</form>
		</div> -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('xip__cache_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">xip_cache.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="pico_8h_source.html">pico.h</a>&quot;</code><br />
<code>#include &quot;hardware/regs/addressmap.h&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for xip_cache.h:</div>
<div class="dyncontent">
<div class="center"><img src="xip__cache_8h__incl.png" border="0" usemap="#ainclude_2hardware_2xip__cache_8h" alt=""/></div>
<map name="ainclude_2hardware_2xip__cache_8h" id="ainclude_2hardware_2xip__cache_8h">
<area shape="rect" title=" " alt="" coords="708,5,867,47"/>
<area shape="rect" href="pico_8h.html" title=" " alt="" coords="649,95,710,121"/>
<area shape="rect" title=" " alt="" coords="1130,244,1341,271"/>
<area shape="rect" href="common_2pico__base__headers_2include_2pico_2types_8h_source.html" title=" " alt="" coords="158,319,259,345"/>
<area shape="rect" title=" " alt="" coords="420,169,533,196"/>
<area shape="rect" href="common_2pico__base__headers_2include_2pico_2config_8h_source.html" title=" " alt="" coords="558,169,662,196"/>
<area shape="rect" href="platform_8h.html" title=" " alt="" coords="687,169,808,196"/>
<area shape="rect" href="error_8h_source.html" title=" " alt="" coords="832,169,927,196"/>
<area shape="rect" href="assert_8h_source.html" title=" " alt="" coords="5,393,111,420"/>
<area shape="rect" title=" " alt="" coords="74,468,157,495"/>
<area shape="rect" title=" " alt="" coords="211,393,281,420"/>
<area shape="rect" title=" " alt="" coords="306,393,381,420"/>
<area shape="rect" title=" " alt="" coords="173,244,337,271"/>
<area shape="rect" href="compiler_8h_source.html" title=" " alt="" coords="362,244,543,271"/>
<area shape="rect" href="sections_8h_source.html" title=" " alt="" coords="567,244,746,271"/>
<area shape="rect" href="panic_8h_source.html" title=" " alt="" coords="770,244,930,271"/>
<area shape="rect" title=" " alt="" coords="955,244,1105,271"/>
<area shape="rect" title=" " alt="" coords="357,319,548,345"/>
</map>
</div>
</div>
<p><a href="xip__cache_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:adfd8a491b5071cbce1bfd5e5078c96bd"><td class="memItemLeft" align="right" valign="top"><a id="adfd8a491b5071cbce1bfd5e5078c96bd" name="adfd8a491b5071cbce1bfd5e5078c96bd"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>PARAM_ASSERTIONS_ENABLED_HARDWARE_XIP_CACHE</b>&#160;&#160;&#160;0</td></tr>
<tr class="separator:adfd8a491b5071cbce1bfd5e5078c96bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab54195b3f9bb8f8886e8a24d4dbae1ca"><td class="memItemLeft" align="right" valign="top"><a id="ab54195b3f9bb8f8886e8a24d4dbae1ca" name="ab54195b3f9bb8f8886e8a24d4dbae1ca"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>XIP_CACHE_LINE_SIZE</b>&#160;&#160;&#160;_u(8)</td></tr>
<tr class="separator:ab54195b3f9bb8f8886e8a24d4dbae1ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad580775e3c5d5c685779c9e22c5ebd7b"><td class="memItemLeft" align="right" valign="top"><a id="ad580775e3c5d5c685779c9e22c5ebd7b" name="ad580775e3c5d5c685779c9e22c5ebd7b"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>XIP_CACHE_SIZE</b>&#160;&#160;&#160;(_u(16) * _u(1024))</td></tr>
<tr class="separator:ad580775e3c5d5c685779c9e22c5ebd7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a037be08dbdd33ca519a37056cd89affb"><td class="memItemLeft" align="right" valign="top"><a id="a037be08dbdd33ca519a37056cd89affb" name="a037be08dbdd33ca519a37056cd89affb"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>XIP_CACHE_ADDRESS_SPACE_SIZE</b>&#160;&#160;&#160;(_u(16) * _u(1024) * _u(1024))</td></tr>
<tr class="separator:a037be08dbdd33ca519a37056cd89affb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af23851ad95bebf0a51eec0c8e87d2453"><td class="memItemLeft" align="right" valign="top"><a id="af23851ad95bebf0a51eec0c8e87d2453" name="af23851ad95bebf0a51eec0c8e87d2453"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>XIP_CACHE_IS_READ_ONLY</b>&#160;&#160;&#160;1</td></tr>
<tr class="separator:af23851ad95bebf0a51eec0c8e87d2453"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga080199b0a555c0f19ff05a298fa97676"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__xip__cache.html#ga080199b0a555c0f19ff05a298fa97676">xip_cache_invalidate_all</a> (void)</td></tr>
<tr class="memdesc:ga080199b0a555c0f19ff05a298fa97676"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invalidate the cache for the entire XIP address space.  <a href="group__hardware__xip__cache.html#ga080199b0a555c0f19ff05a298fa97676">More...</a><br /></td></tr>
<tr class="separator:ga080199b0a555c0f19ff05a298fa97676"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1594edcbd2868564b190f3374d3f49eb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__xip__cache.html#ga1594edcbd2868564b190f3374d3f49eb">xip_cache_invalidate_range</a> (uintptr_t start_offset, uintptr_t size_bytes)</td></tr>
<tr class="memdesc:ga1594edcbd2868564b190f3374d3f49eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invalidate a range of offsets within the XIP address space.  <a href="group__hardware__xip__cache.html#ga1594edcbd2868564b190f3374d3f49eb">More...</a><br /></td></tr>
<tr class="separator:ga1594edcbd2868564b190f3374d3f49eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab7db8e534f4d6ff4a5fb7b022c3034a4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__xip__cache.html#gab7db8e534f4d6ff4a5fb7b022c3034a4">xip_cache_clean_all</a> (void)</td></tr>
<tr class="memdesc:gab7db8e534f4d6ff4a5fb7b022c3034a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clean the cache for the entire XIP address space.  <a href="group__hardware__xip__cache.html#gab7db8e534f4d6ff4a5fb7b022c3034a4">More...</a><br /></td></tr>
<tr class="separator:gab7db8e534f4d6ff4a5fb7b022c3034a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2d424f9667df473c64d6414f31ad1201"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__xip__cache.html#ga2d424f9667df473c64d6414f31ad1201">xip_cache_clean_range</a> (uintptr_t start_offset, uintptr_t size_bytes)</td></tr>
<tr class="memdesc:ga2d424f9667df473c64d6414f31ad1201"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clean a range of offsets within the XIP address space.  <a href="group__hardware__xip__cache.html#ga2d424f9667df473c64d6414f31ad1201">More...</a><br /></td></tr>
<tr class="separator:ga2d424f9667df473c64d6414f31ad1201"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab7c42d3c55382977cd691c6535a6aff9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__xip__cache.html#gab7c42d3c55382977cd691c6535a6aff9">xip_cache_pin_range</a> (uintptr_t start_offset, uintptr_t size_bytes)</td></tr>
<tr class="memdesc:gab7c42d3c55382977cd691c6535a6aff9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pin a range of offsets within the XIP address space.  <a href="group__hardware__xip__cache.html#gab7c42d3c55382977cd691c6535a6aff9">More...</a><br /></td></tr>
<tr class="separator:gab7c42d3c55382977cd691c6535a6aff9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->

	<script src="main.js"></script>
</body>
</html>